Document method comment style - #12338
Open
mhlidd wants to merge 1 commit into
Open
Conversation
mhlidd
added
type: documentation
comp: tooling
mhlidd
marked this pull request as ready for review
August 28, 2026 21:46
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
More details
The new rule applies only to agent instructions. It does not change runtime code.
🤖 Datadog Autotest · Commit cbc899f · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
Contributor
🟢 Java Benchmark SLOs — All performance SLOs passed
PR vs. master results
Commit: Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Does This Do
Adds an agent code convention requiring concise Javadoc comments for documentation that applies to an entire method, rather than line comments or plain block comments.
Motivation
Keeps method-level documentation discoverable through Java tooling while preventing verbose comments from obscuring the implementation.
Additional Notes
This is an instruction-only change with no runtime impact.
Contributor Checklist
type:and (comp:orinst:) labels in addition to any other useful labelsclose,fix, or any linking keywords when referencing an issueJira ticket: N/A